Versions:
terraform-docs is a command-line utility designed to generate human-readable documentation directly from Terraform modules, eliminating the need to maintain separate README files by hand. Operating in the Developer Tools category, it parses variable, output, resource, and provider declarations within any .tf repository and renders them into structured formats such as Markdown, JSON, AsciiDoc, CSV, XML, or even PDF. Typical use cases include embedding always-up-to-date module usage examples into GitHub READMEs, feeding JSON metadata into downstream compliance pipelines, and producing customer-facing PDFs for regulated environments. Because the tool is invoked from CI/CD stages, teams can guarantee that published documentation stays synchronized with every commit, pull request, or release. The open-source project maintains six major releases to date, with version 0.21.0 introducing performance improvements for deeply nested modules, tighter integration with Terraform 1.5 syntax, and experimental support for provider-specific annotations. Installation options include pre-built binaries for Windows, macOS, and Linux, container images, and package managers such as Homebrew, Chocolatey, and scoop; the Windows winget repository is also supported for one-line setup. terraform-docs can be configured through a simple .terraform-docs.yml file placed in the module root, allowing maintainers to choose sections, order, and indention style, and to inject custom content around auto-generated tables. Community-contributed plugins extend output possibilities to Confluence, Slack, or Terraform Registry metadata, further broadening the utility’s role in documentation automation workflows. The software is available for free on get.nero.com, with downloads provided via trusted Windows package sources (e.g. winget), always delivering the latest version, and supporting batch installation of multiple applications.
Tags: